// -*- mode:c++ -*-
//
// 2009-2010 HIT Microelectronic Center all rights reserved
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met: redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer;
// redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution;
// neither the name of the copyright holders nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//
// Date: Dec. 2009
// Authors: Gou Pengfei

output header {{
	class M3Op:public TRIPSStaticInst
	{
		protected:

		/// Predication bits
		uint8_t pr;

		/// Constructors for TRIPS G format instructions
		M3Op(const char* mnem, MachInst _machInst, OpClass __opClass):
			TRIPSStaticInst(mnem, _machInst, __opClass),pr(PR)
		{
			switch(pr){
				case 0x0:_predication = Disable;break;
				case 0x2:_predication = PredUponFalse;break;
				case 0x3:_predication = PredUponTrue;break;
				default: _predication = Reserved; 
			}
			// This is explicitly statments of consumers due to the special coding format of m3 instruction
			_numConsumers = 3;
			_consumerID[0] = ( M3TX << 7 ) | M3T0;
			_consumerID[1] = ( M3TX << 7 ) | M3T1;
			_consumerID[2] = ( M3TX << 7 ) | M3T2;
		}
		
		std::string generateDisassembly(Addr pc, const SymbolTable *symTab) const;
	};
	class M4Op:public TRIPSStaticInst
	{
		protected:

		/// Constructors for TRIPS G format instructions
		M4Op(const char* mnem, MachInst _machInst, OpClass __opClass):
			TRIPSStaticInst(mnem, _machInst, __opClass)
		{
			// This is explicitly statments of consumers due to the special coding format of m4 instruction
			_numConsumers = 4;
			_consumerID[0] = ( M4TX << 5 ) | M4T0;
			_consumerID[1] = ( M4TX << 5 ) | M4T1;
			_consumerID[2] = ( M4TX << 5 ) | M4T2;
			_consumerID[3] = ( M4TX << 5 ) | M4T3;
			_predication =Disable;
		}
		
		std::string generateDisassembly(Addr pc, const SymbolTable *symTab) const;
	};

}};

output decoder {{
	std::string M3Op::generateDisassembly(Addr pc, const SymbolTable* symtab) const {
		std::stringstream ss;
		ccprintf(ss, "%-10s",mnemonic);
		ss<<" ";
		ccprintf(ss, "PR[%d]", pr);
		ss<<",";
		printConsumer(ss, 0);
		printConsumer(ss, 1);
		printConsumer(ss, 2);
		return ss.str();
	}
	std::string M4Op::generateDisassembly(Addr pc, const SymbolTable* symtab) const {
		std::stringstream ss;
		ccprintf(ss, "%-10s",mnemonic);
		ss<<" ";
		printConsumer(ss, 0);
		printConsumer(ss, 1);
		printConsumer(ss, 2);
		printConsumer(ss, 3);
		return ss.str();
	}
}};

//
// Dec. 2009, Gou Pengfei
// Since M3 and M4 is different in consumer encoding than any other instructions, 
// so I put the consumers statement codes directyly into constructors of its parent class.
// This is not good enough right now. Maybe some one can figure out a better way to 
// represent an arbitrary consumer ID encoding.
//
def format M3Op(code,*opt_flags) {{
	opt_flags+=('IQOPerands',)
	iop = InstObjParams(name,Name,'M3Op',code,opt_flags)
	header_output = BasicDeclare.subst(iop)
	decoder_output = BasicConstructor.subst(iop)
	decode_block = BasicDecode.subst(iop)
	exec_output = BasicExecute.subst(iop)
}};

def format M4Op(code,*opt_flags) {{
	opt_flags+=('IQOPerands',)
	iop = InstObjParams(name,Name,'M4Op',code,opt_flags)
	header_output = BasicDeclare.subst(iop)
	decoder_output = BasicConstructor.subst(iop)
	decode_block = BasicDecode.subst(iop)
	exec_output = BasicExecute.subst(iop)
}};
